home *** CD-ROM | disk | FTP | other *** search
/ PC World Komputer 2010 April / PCWorld0410.iso / hity wydania / Ubuntu 9.10 PL / karmelkowy-koliberek-desktop-9.10-i386-PL.iso / casper / filesystem.squashfs / usr / share / doc / libxml-twig-perl / README < prev   
Text File  |  2007-07-20  |  3KB  |  107 lines
  1. NAME
  2.  
  3.     XML::Twig - Tree interface to XML documents allowing processing chunk
  4.                 by chunk of huge documents.
  5.  
  6.                 
  7.  
  8. SUMMARY (see perldoc XML::Twig for full details)
  9.  
  10. XML::Twig is (yet another!) XML transformation module. 
  11.  
  12. Its strong points: can be used to process huge documents while still
  13. being in tree mode; not bound by DOM or SAX, so it is very perlish and
  14. offers a very comprehensive set of methods; simple to use; DWIMs as
  15. much as possible
  16.  
  17. What it doesn't offer: full SAX support (it can export SAX, but only
  18. reads XML), full XPath support (unless you use XML::Twig::XPath), nor
  19. DOM support.
  20.  
  21. Other drawbacks: it is a big module, and with over 500 methods available
  22. it can be a bit overwhelming. A good starting point is the tutorial at
  23. http://xmltwig.com/xmltwig/tutorial/index.html. In fact the whole
  24. XML::Twig page at http://xmltwig.com/xmltwig/ has plenty of information
  25. to get you started with XML::Twig
  26.  
  27. TOOLS
  28.  
  29. XML::Twig comes with a few tools built on top of it:
  30.  
  31.   xml_pp           XML pretty printer
  32.   xml_grep         XML grep - grep XML files using XML::Twig's subset of XPath
  33.   xml_split        split big XML files
  34.   xml_merge        merge back files created by xml_split
  35.   xml_spellcheck   spellcheck XML files skipping tags
  36.  
  37. Running perl Makefile.PL will prompt you for each tool installation. 
  38.   perl Makefile -y     will install all of the tools without prompt
  39.   perl Makefile -n     will skip the installation of the tools
  40.  
  41.  
  42. SYNOPSYS
  43.  
  44.   single-tree mode    
  45.     my $t= XML::Twig->new();
  46.     $t->parsefile( 'doc.xml');
  47.     $t->print;
  48.  
  49.   chunk mode 
  50.     # print the document, at most one full section is loaded in memory
  51.     my $t= XML::Twig->new( twig_handlers => { section => \&flush});
  52.     $t->parsefile( 'doc.xml');
  53.     $t->flush;
  54.     sub flush { (my $twig, $section)= @_; $twig->flush; }
  55.     
  56.   sub-tree mode 
  57.     # print all section title's in the document,
  58.     # all other elements are ignored (and not stored)
  59.     my $t= XML::Twig->new( 
  60.             twig_roots => { 'section/title' => sub { $_->print, "\n" } }
  61.                          );
  62.     $t->parsefile( 'doc.xml');
  63.     
  64. INSTALLATION
  65.  
  66.     perl Makefile.PL
  67.     make
  68.     make test
  69.     make install
  70.  
  71. DEPENDANCIES
  72.  
  73.     XML::Twig needs XML::Parser (and the expat library) installed
  74.    
  75.     Modules that can enhance XML::Twig are:
  76.  
  77.     Scalar::Util or WeakRef 
  78.       to avoid memory leaks
  79.     Encode or Text::Iconv or Unicode::Map8 and Unicode::Strings 
  80.       to do encoding conversions
  81.     Tie::IxHash 
  82.       to use the keep_atts_order option
  83.     XML::XPath 
  84.       to use XML::Twig::XPath
  85.     LWP 
  86.       to use parseurl
  87.     HTML::Entities
  88.       to use the html_encode filter
  89.  
  90. CHANGES
  91.  
  92.     $Id: /xmltwig/trunk/README 4 2007-03-16T12:16:25.259192Z mrodrigu  $
  93.  
  94.     See the Changes file    
  95.  
  96. AUTHOR
  97.  
  98.     Michel Rodriguez (mirod@cpan.org)
  99.     The Twig page is at http://www.xmltwig.com/xmltwig
  100.     See the XML::Twig tutorial at http://www.xmltwig.com/xmltwig/tutorial/index.html
  101.  
  102. COPYRIGHT
  103.  
  104.        Copyright (c) 1999-2005, Michel Rodriguez. All Rights Reserved.
  105.        This library is free software; you can redistribute it and/or modify
  106.        it under the same terms as Perl itself.
  107.